Отслеживание заказа
Запрос позволяет узнать статус заказа и местонахождение машины, которая была назначена вашему заказу.
Синтаксис запроса
GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/order/{идентификатор заказа}/progress
🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.
Заголовки запроса:
Authorization
OAuth-токен. Процесс получения токена описан в разделе Начало работы.
Описание полей ответа
В ответе могут содержаться следующие поля:
Поле | Описание | Формат |
---|---|---|
status |
Статус заказа. Возможные значения: - search — заказ создан и осуществляется поиск водителя.- driving — водитель найден и едет к месту подачи автомобиля.- waiting — водитель прибыл и ожидает сотрудника.- transporting — сотрудник сел в машину и находится в пути.- complete — заказ завершен успешно.- cancelled — заказ отменен по инициативе клиента или его сотрудника.- failed — заказ отменен таксопарком, так как водитель не может его выполнить.- expired — статус заказа неизвестен. Данный статус может возвращается, если таксопарк вовремя не прислал данные о состоянии заказа.- scheduling — заказ создан, поиск водителя будет начат за некоторое время до подачи автомобиля.- scheduled — заказ создан, водитель назначен и выедет к сотруднику согласно времени подачи. Заказ в этом статусе может быть изменен. |
Строка |
vehicle |
Информация о машине, если она была назначена для вашего заказа. | Объект |
location |
Координаты машины. | Строка |
Пример запроса
GET https://business.taxi.yandex.ru/api/1.0/client/a2d...d09/order/8b8...432/progress
...
Authorization: <OAuth-токен>
Пример ответа
Пример ответа на данный запрос выглядит следующим образом:
{
"status": "finished",
"vehicle": {
"location": [55.749884, 37.589688]
}
}
Возможные коды ответа
Ответ на данный запрос может содержать следующие стандартные HTTP-коды:
200
— запрос выполнен успешно.401
— был передан неверный OAuth-токен.403
— у клиента не хватает прав на выполнение данного запроса.404
— запрашиваемая запись не найдена.
Скопировано
Была ли статья полезна?
Предыдущая
Следующая